home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / programs / au512c.zip / QWIKER.DOC < prev    next >
Text File  |  1992-03-26  |  62KB  |  1,438 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.            QWiKer version 0.65 - the QWK compatible interface for Auntie
  27.                                  QWiKer is Quicker
  28.  
  29.                                    SysOp's Manual
  30.                      Copyright (C) 1991, 1992 by DataWare, Inc.
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.        System Overview                                            1
  38.        License and Warnings                                       2
  39.        System Requirements                                        2
  40.        Setup                                                      3
  41.            Step 1 - Create a QWIKER.CFG file                      3
  42.            Step 2 - Copy the .EXE files                           5
  43.            Step 3 - Check your Auntie configuration               5
  44.            Step 4 - Update your external command list             6
  45.            Step 5 - (Optional) Update your synonym list           6
  46.            Step 6 - (Optional) Multi-node sysops add CONFIG=      6
  47.            Step 7 - (Optional) Netmail                            7
  48.            Step 8 - (Optional) Setup ALIAS.NAM file               8
  49.        System Operation                                           9
  50.        Technical Support                                         13
  51.        Registration                                              13
  52.        Appendix A - Technical layout of files used by QWiKer     14
  53.            EXTERNAL.DTA                                          14
  54.            ADDMARK.LST                                           14
  55.        Appendix B - QWK-REP Mail Packet File Formats             15
  56.            2QWK Mail Packet Structure Definition                 15
  57.            MESSAGES.DAT File Format                              15
  58.            Modification for Netmail packets                      16
  59.            nnn.NDX File Format                                   16
  60.            CONTROL.DAT File Format                               17
  61.            BULLETINS Format                                      18
  62.            REP Mail Packet Structure Definitions                 19
  63.        History                                                   20
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.                                           i
  95.  
  96.  
  97.  
  98.  
  99.  
  100.        System Overview       System Overview
  101.        ──────────────────────────────────────────────────────────────────────
  102.        Over the last 4 years, offline messaging has become fairly popular in
  103.        the BBS community.  For those unfamiliar with what offline messaging
  104.        is, let me explain.  Offline messaging is a way in which users may
  105.        download compressed packets of mail (i.e. messages taken from the
  106.        BBS's message base) and upload their replies to those messages which
  107.        get stored directly in the BBS's message base.  There are many
  108.        advantages to this.
  109.  
  110.           - First, the users time is freed up.  By doing all their messaging
  111.             offline, they may spend more time while on the BBS doing other
  112.             things.
  113.           - The number of users that can get through during the day is
  114.             greater because the average amount of time spent on-line is
  115.             significantly reduced.
  116.           - The users may also spend as much time as they wish reading and
  117.             replying to their mail and not have to worry about the BBS timer
  118.             running out on them.
  119.           - The users can participate in more conferences then would be
  120.             reasonable when doing on-line messaging.  For BBS's connected to
  121.             netmail networks, this is especially important as the number of
  122.             conferences the BBS offered can number in the hundreds.
  123.           - Long distance callers can lower their long distance bill by doing
  124.             all their messaging offline.
  125.  
  126.        Many file formats exist in the BBS community for doing offline
  127.        messaging.  Most formats are specific to one particular BBS platform.
  128.        Such as Teleguard has it's own format and mail reader.  GT Powercomm
  129.        has it's own.  Opus also has it's own.  One format that is becoming
  130.        very popular among multiple BBS platforms is the QWK-REP standard.  It
  131.        was invented by Mark (Sparky) Herring about 5 years ago, and is now
  132.        available on PCBoard, Wildcat, TriTel, Gap and a few others.
  133.  
  134.        And now with the help of QWiKer, Auntie is included in the list of BBS
  135.        platforms that have a QWK-REP compatible mail packet interface.  Using
  136.        QWiKer, your users will be able to download .QWK compatible mail
  137.        packets and upload .REP compatible mail packets.  Users will be able
  138.        to use their favorite .QWK compatible off-line reader for reading and
  139.        replying to their own mail (there are many QWK-REP compatible offline
  140.        readers to choose from).  They can even control their selection of
  141.        message areas spread out across multiple Auntie forums with their mail
  142.        reader program.  Additionally, QWiKer allows your BBS to act as a QWK-
  143.        REP compatible mail HUB for other BBS nodes to call into.  However,
  144.        the one thing that QWiKer does NOT do, is enable your BBS to be a node
  145.        calling another mail HUB for netmail.  For this you will need the
  146.        QWiKerNet product also produced by Dataware.
  147.  
  148.        QWiKer is also lightning fast in creating .QWK packets.  A 386-25Mhz
  149.        running under MS-DOS 3.3 can generate an 800 message packet in 1:09
  150.        minutes for 2400 bps callers, or 0:30 minutes for 4800 bps and greater
  151.        callers and in local mode.  A 386SX-16 running under DESQview can
  152.        generate the same 800 message packet in 2:12 minutes for 2400 bps baud
  153.        callers, or 0:55 minutes for 4800 bps or greater callers and in local
  154.        mode.
  155.  
  156.  
  157.  
  158.                                           1
  159.  
  160.  
  161.  
  162.  
  163.  
  164.        License and Warnings       License and Warnings
  165.        ──────────────────────────────────────────────────────────────────────
  166.        You are hereby granted a license to evaluate this software for a
  167.        period of sixty (60) days.  If on or before this time expires, you
  168.        wish to continue using this software, registration of this software as
  169.        outlined in the Registration section is required.
  170.  
  171.        You are free to copy and distribute this software PROVIDED:
  172.  
  173.             - No fee is charged for its use, copying or distribution.
  174.             - It is not modified in ANY way.
  175.  
  176.        Dataware hereby disclaims all warranties relating to this software,
  177.        whether express or implied, including without limitation any implied
  178.        warranties of merchantability or fitness for a particular purpose.
  179.        Dataware will not be liable for any special, incidental,
  180.        consequential, indirect or similar damages due to loss of data or any
  181.        other reason, even if Dataware or an agent of Dataware has been
  182.        advised of the possibility of such damages.  In no event shall
  183.        Dataware's liability for any damages ever exceed the price paid for
  184.        the license to use software, regardless of the form of the claim.  The
  185.        person using the software bears all risk as to the quality and
  186.        performance of the software.
  187.  
  188.        In other words... I believe this version to be bug and virus free.
  189.        However, if this program starts wiping out your files, or otherwise
  190.        starts damaging your computer, I will NOT be held responsible for it.
  191.        If you do experience any problems with QWiKer, I would very much like
  192.        you to drop me a line and I will do my best to fix the problem.  See
  193.        the section entitled Technical Support on how to reach Dataware.
  194.  
  195.  
  196.        System Requirements       System Requirements
  197.        ──────────────────────────────────────────────────────────────────────
  198.        QWiKer doesn't need much that you haven't already got with your Auntie
  199.        BBS.  It is recommended (but not required) that you point your
  200.        "Temporary path" to as large of a RAM disk as possible, and your "Path
  201.        to downloadable files not listed in DIR" to a real hard drive.  If
  202.        both paths point to the same location (such as a RAM drive), a 1Mb RAM
  203.        drive is enough to create a QWK packet containing about 600-700
  204.        messages (depending on the size of each message).  If the two paths
  205.        point to different locations, a 1Mb RAM drive (assuming the "Temporary
  206.        path" points to a RAM drive) is enough for about 800-1000 messages.
  207.  
  208.        This version of QWiKer does require Auntie 512 dated 09/19/91 or
  209.        later.  The program files take 43Kb of disk space and about 96Kb of
  210.        memory space to run in, depending on your system configuration.3
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.                                           2
  223.  
  224.  
  225.  
  226.  
  227.  
  228.        Setup       Setup
  229.        ──────────────────────────────────────────────────────────────────────
  230.  
  231.  
  232.        Step 1 - Create a QWIKER.CFG file       Step 1 - Create a QWIKER.CFG file
  233.        ──────────────────────────────────────────────────────────────────────
  234.        The first thing you will need to do is create a QWIKER.CFG file.  This
  235.        file contains configuration information that QWiKer will use during
  236.        it's processing, in combination with the information extracted from
  237.        the BBSWES.CFG file and the USERS. file.  QWIKER.CFG can be created
  238.        using your favorite text editor.  A QWIKER.CFG file is included in the
  239.        package as an example to follow.
  240.  
  241.        The QWIKER.CFG configuration file is a text file that uses the
  242.        "KEYWORD=" syntax.  Each line starts with a key word (a list of
  243.        recognized key words follows), and the definition for the key word
  244.        following the "=" character.  White space (tabs and space characters)
  245.        are permissible to make the file more readable, as well as blank
  246.        lines.  Case is also unimportant.  I use mixed case to make the file
  247.        more readable.  QWiKer will remove and ignore all white space as it
  248.        parses the configuration file, as well as convert everything to upper
  249.        case.  If you wish to maintain the white space in your definitions,
  250.        you must surround the text with quotes.  Comments are also allowed in
  251.        the configuration file, and are defined as any text following a ";"
  252.        character up to the end of the line (a CR/LF pair).  Unknown key words
  253.        will be ignored, which allows you to copy definitions to/from a
  254.        QWiKerNet configuration file.
  255.  
  256.        You MUST have exactly one of each of the following key words:                     ___________
  257.  
  258.        BBSName=    The name of your BBS as will be shown to the user by the
  259.                    off-line reader program.  For example: 'BBSName = "The
  260.                    Real Batchin' Board"'.
  261.  
  262.        BBSLocation=   The City, State that your BBS is located in as will be
  263.                    shown to the user by the off-line reader program.  For
  264.                    example: 'BBSLocation = "Issaquah, Wa"'.
  265.  
  266.        BBSPhone=   The main phone number of your BBS as will be shown to the
  267.                    user by the off-line reader program.  For example:
  268.                    'BBSPhone = 206-391-2330'.
  269.  
  270.        You may optionally include either or both of the following two key
  271.        words:
  272.  
  273.        NetMailFlag=   An optional key word that identifies which user flag
  274.                    (57-64) is used to indicate that the user is a netmail
  275.                    caller, and to send QWK packets formatted for netmail and
  276.                    accept REP packets formatted for netmail. For example:
  277.                    'NetMailFlag = 57'.  If this keyword is left out, QWiKer
  278.                    will never test for netmail callers.
  279.  
  280.        TimeStamp=  Controls the timestamp on messages as they are stored in
  281.                    the message base.  Can be set to either "Today" or
  282.                    "Message".  When set to "Today", the message is stored
  283.  
  284.  
  285.  
  286.                                           3
  287.  
  288.  
  289.  
  290.  
  291.  
  292.                    with the systems current date and time.  When set to
  293.                    "Message", the message is stored with the messages
  294.                    creation date taken from the message header.  For example:
  295.                    'TimeStamp = Today'.  If this keyword is left out, the
  296.                    "Message" setting is assumed.
  297.  
  298.        If you have more then just your main Auntie forum that you want QWiKer
  299.        to be able to access, you must include one "Forum n=" definition for
  300.        each additional forum QWiKer is to access.  Otherwise leave out any
  301.        "Forum n=" definitions (or include a commented out "Forum 1"
  302.        definition for clarity).
  303.  
  304.        Forum n=    Path pointing to one of your BBSWES.CFG files.  "n" must
  305.                    be a number from 2-112.  "Forum n" key words are only
  306.                    needed if you have multiple Auntie forums setup on your
  307.                    BBS that you want QWiKer to also be able to scan for
  308.                    messages.  For example: 'Forum 2 = D:\AUNTIE\ADULT"
  309.  
  310.            Note: Forum 1 is automatically assumed to be the current sub-
  311.                  directory.  QWiKer will attempt to open up the BBSWES.CFG
  312.                  file in the current sub-directory, extract the R/W path, the
  313.                  Node Number, the Node path, and the Temp path and use them
  314.                  as specified.
  315.  
  316.        Before describing the "Conference n=" keyword definition, a discussion
  317.        of what a Conference is, is required.  Auntie deals with forums and
  318.        message areas within those forums.  You can have as many forums as you
  319.        wish.  You're only limitation is disk space and the desire to set them
  320.        up.  Message areas are limited to a total of 255 within each forum,
  321.        numbered 1-255.  Offline readers on the other hand only deal with
  322.        conferences.  Conferences are limited to a total of 8192, numbered 0-
  323.        8191 (however, QWiKer is currently programmed to only handle
  324.        conferences numbered 0-1023).  What QWiKer does is to map message
  325.        areas to conferences.
  326.  
  327.        What you do using the "Conference n=" keyword is to define which
  328.        message area of which forum is to map into what conference.  You must
  329.        have exactly one "Conference n=" definition for each and every message            ___________
  330.        area you wish your users to have access to via QWiKer.  BE VERY
  331.        CAREFUL NOT TO MAP THE SAME MESSAGE AREA INTO MULTIPLE CONFERENCES, OR
  332.        DEFINE THE SAME CONFERENCE NUMBER MORE THEN ONCE.  Cross echoes and
  333.        duplicate messages can be the result of one small configuration error.
  334.  
  335.        Conference n=  A QWK-REP packet conference number to Auntie message
  336.                    area mapping assignment.  "n" can range from 0-1023.
  337.                    QWiKer recognizes 4 sub-keys within the "Conference n="
  338.                    key word definition.  They must all be included and each
  339.                    one must be separated by a "," character, but may be
  340.                    placed in any order within the definition so long as they
  341.                    are all placed on the same line following the "Conference
  342.                    n=" key word.  For example: 'Conference 1 = F1, A1, PY,
  343.                    N"MainBoard"'.  Unknown sub-keys are ignored, which allows
  344.                    you to copy the definitions to/from a QWiKerNet
  345.                    configuration file.  The sub-keys are:
  346.  
  347.  
  348.  
  349.  
  350.                                           4
  351.  
  352.  
  353.  
  354.  
  355.  
  356.                    Fn -   Forum number this conference is assigned to.  Must
  357.                           be 1-n, where n is either 1 or the highest "Forum
  358.                           n" definition you've declared.
  359.  
  360.                    An -   Message area this conference is mapped to within
  361.                           the Forum.  Must be 1-255.
  362.  
  363.                    PY/PN - Private messages are supported or not supported in
  364.                           this conference.  If configured for PN, any
  365.                           messages marked as "Private" that QWiKer comes
  366.                           across will simply be skipped.  Note: Private
  367.                           messages received in REP packets will be stored as
  368.                           private messages in the message base regardless of
  369.                           this setting.  This setting only affects which
  370.                           messages will be included in QWK packets.
  371.  
  372.                    Nxx -  A name for the conference as will be shown to the
  373.                           user by the off-line reader program.  Limited to 10
  374.                           characters in length and should not contain spaces.
  375.                           The name should be surrounded by quotes so as to
  376.                           not be misinterpreted as another key word by
  377.                           mistake.
  378.  
  379.            Note: It is highly recommended that you skip Conference 0 and
  380.                  start with Conference 1 mapping into message area 1 of forum
  381.                  1 wherever possible.  This provides a one to one mapping of
  382.                  conference numbers to message area numbers, which helps in
  383.                  eliminating confusion by the user and sysop alike.
  384.  
  385.        One you've created the file QWIKER.CFG, you have the choice of putting
  386.        it into the same sub-directory where your BBSWES.CFG file is located,
  387.        or point to its location by including the "CONFIG=" parameter on the
  388.        command line of MAKEQWK and UNPAKREP.  How to specify this command
  389.        line parameter is explained in step 6 below.  Multi-node operators
  390.        will appreciate the latter because it allows you to maintain only one
  391.        QWIKER.CFG file for all nodes.  If QWiKer is unable to locate the
  392.        QWIKER.CFG file either where "CONFIG=" points to or in the current
  393.        sub-directory it will complain and abort.
  394.  
  395.  
  396.        Step 2 - Copy the .EXE files       Step 2 - Copy the .EXE files
  397.        ──────────────────────────────────────────────────────────────────────
  398.        Place all of the executable files (MAKEQWK.EXE, UNPAKREP.EXE and
  399.        QWKCLNUP.EXE) somewhere in your DOS Path.  I have mine in D:\, which
  400.        is the first entry of my DOS Path list.
  401.  
  402.  
  403.        Step 3 - Check your Auntie configuration       Step 3 - Check your Auntie configuration
  404.        ──────────────────────────────────────────────────────────────────────
  405.        Run the Auntie CONFIG program and under the "Paths and Sub-
  406.        directories" menu, make sure your "Path to Downloadable Files Not
  407.        Listed in DIR" and your "Temporary path" are set the way you want them
  408.        to be.  QWiKer builds all its work files in the Temporary path, and
  409.        puts the finished QWK packet in the "Not Listed in DIR" path.
  410.  
  411.  
  412.  
  413.  
  414.                                           5
  415.  
  416.  
  417.  
  418.  
  419.  
  420.        QWiKer will work best if your Temporary path points to a large RAM
  421.        drive (at least 1Mb is recommended in order to handle the larger QWK
  422.        packets) and your Path to Downloadable Files Not Listed in DIR points
  423.        to a real hard drive.  But this is not a required configuration.
  424.  
  425.        Step 4 - Update your external command list       Step 4 - Update your external command list
  426.        ──────────────────────────────────────────────────────────────────────
  427.        Add MAKEQWK to your external command list file.  It accepts two
  428.        command line parameters.  The first parameter specifies the maximum
  429.        number of messages to put into a QWK packet.  This allows you to
  430.        prevent a disk full error during processing, as well as control the
  431.        maximum packet size a user can download at once.  The second parameter
  432.        is the maximum number of messages per message area to put into the
  433.        packet.  When this limit is reached in any message area, QWiKer stops
  434.        scanning and proceeds to the next step in generating the QWK packet.
  435.        If you do not include either parameter on the command line, it will
  436.        default to a limit of 600x200.  I recommend that you leave the second
  437.        parameter at 200 or less.  A few of the off-line readers will actually
  438.        crash if more than 200 messages are contained in any single message
  439.        area.  A MAKEQWK external command line looks like:
  440.  
  441.        qmd, 2, "makeqwk 1500 200",
  442.  
  443.        The "2" in this line is the minimum access level required for the user
  444.        to access this command.  If the users access level is not 2 or
  445.        greater, that user will not be able to access the command.  Substitute
  446.        the "2" with whatever minimum access level you have chosen for your
  447.        users to access the QMD command.
  448.  
  449.        NOTE: MAKEQWK will automatically set the second parameter to unlimited
  450.        (i.e. ignore the second parameter) for callers who have their Netmail
  451.        flag turned on.
  452.  
  453.        Step 5 - (Optional) Update your synonym list       Step 5 - (Optional) Update your synonym list
  454.        ──────────────────────────────────────────────────────────────────────
  455.        Add four lines in your SYN.LST file that read something like:
  456.  
  457.        2/QMD/QMD/Please standby while I generate a QWK packet for you
  458.        2/QMU/QMU/
  459.        1/QMD//Sorry, your account hasn't been validated for QMD use
  460.        1/QMU//Sorry, your account hasn't been validated for QMU use
  461.  
  462.        This provides access level control for both the QMU and QMD commands.
  463.        The "2" is the minimum access level required for the user to access
  464.        the commands.  If the users access level is not 2 or greater, that
  465.        user will not be able to access the commands.  Substitute the "2" with
  466.        whatever minimum access level you have chosen for users to access
  467.        QWiKer.  Substitute the "1" with one less then the minimum access
  468.        required.
  469.  
  470.        Step 6 - (Optional) Multi-node sysops add CONFIG=       Step 6 - (Optional) Multi-node sysops add CONFIG=
  471.        ──────────────────────────────────────────────────────────────────────
  472.        If you wish to use the optional "CONFIG=" command line parameter, you
  473.        will need to make two changes to the setup thus far.  The entry in
  474.        your external command file will have to be changed to look like:
  475.  
  476.  
  477.  
  478.                                           6
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.        qmd, 2, "makeqwk 1500 200 /Config=D:\BBS\RO",
  486.  
  487.        The "1500 200" is optional, and will default to 600x200 if not
  488.        specified.  The "/Config=D:\BBS\RO" specifies the path to where your
  489.        QWIKER.CFG file is actually stored.  This path can be anything.  Your
  490.        RO path common to all nodes makes an excellent choice.
  491.  
  492.        The next thing you'll need to do is to modify line number 1136 in your
  493.        AUNTEXT. file to also point to your QWIKER.CFG file.  Is should look
  494.        something like:
  495.  
  496.        UNPAKREP /Config=D:\BBS\RO
  497.  
  498.        CAUTION: DON'T FORGET TO RUN MAKANTXT AFTER MAKING THIS CHANGE, AND
  499.        AFTER YOU RECEIVE A NEW AUNTEXT FILE AND REPEATED THE CHANGE IN THE
  500.        NEW FILE.
  501.  
  502.        Step 7 - (Optional) Netmail       Step 7 - (Optional) Netmail
  503.        ──────────────────────────────────────────────────────────────────────
  504.        If you intend to allow downstream nodes call you for echo mail using
  505.        Qnet, Rnet, Tnet, QWiKerNet or any other QWK-REP compatible netmail
  506.        software, you will need to create a FLAG5764.TXT file (or add to your
  507.        existing FLAG5764.TXT file).  The USERSUB program (an Auntie utility)
  508.        uses this file to determine what text to display in its information
  509.        box when the user flags 57-64 are highlighted.
  510.  
  511.        In this file you must put a netmail flag entry.  This file is an
  512.        ordinary text file, and uses the following format:
  513.  
  514.        nn, "Flag text"
  515.  
  516.        where nn is the flag number (values 57-64 permitted only), and "Flag
  517.        text" is the text that will actually be displayed in the USERSUB
  518.        information box when that particular flag number is under the cursor.
  519.  
  520.        Once you have created your FLAG5764.TXT file, place it in your Read
  521.        Write Path sub-directory.  This is where USERSUB expects to find it.
  522.        I have included a sample FLAG5764.TXT file for you to follow.  I have
  523.        chosen to use flag 57 since it's the first one available to me.
  524.        Therefore my entry in FLAG5764.TXT reads:
  525.  
  526.        57, "User is a Netmail caller"
  527.  
  528.        In addition to putting an entry in your FLAG5764.TXT file, you will
  529.        also need to make sure there is a "NetMail=" definition line in your
  530.        QWIKER.CFG file.  On this line you must put the number of the users
  531.        flag that QWiKer will look at to determine if the caller is a netmail
  532.        caller.  The number on this line MUST match the flag number you put on
  533.        your netmail entry line within your FLAG5764.TXT file.  In my case, I
  534.        have the line "NetMail=57" in my QWIKER.CFG file, to match the 57
  535.        stored in my FLAG5764.TXT file.
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.                                           7
  543.  
  544.  
  545.  
  546.  
  547.  
  548.        Step 8 - (Optional) Setup ALIAS.NAM file       Step 8 - (Optional) Setup ALIAS.NAM file
  549.        ──────────────────────────────────────────────────────────────────────
  550.        If you want to allow alias names on your BBS but find that the BBS
  551.        network you're connected to doesn't allow them, QWiKer has the ability
  552.        to translate the name automatically for you.  All you do is create an
  553.        ALIAS.NAM file and fill it with the alias to real name translation
  554.        definitions.  This file is a plain ASCII text file that uses the
  555.        format:
  556.  
  557.        ALIAS NAME = REAL NAME
  558.  
  559.        The first name is the alias name that the caller will be using locally
  560.        on your board.  The second name is the name the alias will be
  561.        translated to/from when exported/imported to/from your downstream
  562.        netmail nodes calling in.  The translation only occurs for those
  563.        callers with the netmail flag turned on.  So that your regular callers
  564.        doing QMD's will see only the alias name in their packets.
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.  
  600.  
  601.  
  602.  
  603.  
  604.  
  605.  
  606.                                           8
  607.  
  608.  
  609.  
  610.  
  611.  
  612.        System Operation       System Operation
  613.        ──────────────────────────────────────────────────────────────────────
  614.        Once QWiKer has been properly installed and configured, two new
  615.        commands become active and available to the users.  These commands are
  616.        "QMD" and "QMU" which stand for QwkMail Download and QwkMail Upload.
  617.        QMD is used to generate and download a .QWK mail packet (a compressed
  618.        file containing messages extracted from the BBS message base).  QMU is
  619.        used to upload a .REP mail packet (a compressed file containing
  620.        replies and new messages typed up by the user while using an offline
  621.        reader program) and insert the messages into the BBS message base.
  622.  
  623.        The general sequence of events is:
  624.  
  625.          1. The user first logs on and runs the QMD command downloading a
  626.             .QWK packet as the final result.
  627.          2. The user then logs off the BBS, possibly after doing other things
  628.             since they still have ample system time available for use.
  629.          3. Now using any of the available QWK compatible offline readers
  630.             (the user can choose from EZ-Reader, SLMR, KingQWK, Session
  631.             Manager, Qdeluxe 2, Megamail, WinQWK, and many others) the user
  632.             opens up the .QWK packet and reads the messages it contains.
  633.          4. The user enters replies to messages and new messages via the
  634.             offline reader program, which generates a .REP packet containing
  635.             the users messages.
  636.          5. Next the user logs back onto the system and by using the QMU
  637.             command, uploads the .REP packet which unpacks it and stores the
  638.             message(s) into the message base.
  639.  
  640.        If your BBS is part of a netmail network, a user can cause any message
  641.        to be stored with the No Echo flag turned on such that the message
  642.        will remain local to your BBS and won't be echoed to any other system.
  643.        The user accomplishes this by prefacing the subject field with the
  644.        characters "NE:".  QWiKer triggers off of this and will turn on the No
  645.        Echo flag as the message is stored when the first 3 characters match
  646.        (case insensitive).  It also strips the characters from the subject
  647.        field so that other people viewing the message won't see "NE:" in the
  648.        subject field.
  649.  
  650.        As of version 0.62, users are able to reset their Hi Message Pointers
  651.        automatically, all at once by including the HMP.PTR file in an
  652.        uploaded REP packet.  What the user does is to extract (PKUNZIP) the
  653.        HMP.PTR file from their last good .QWK packet, include it in a .REP
  654.        packet (PKZIP) and upload that .REP packet. Upon receipt, QWiKer will
  655.        reset all of the users HMP's to be equal to their values AFTER the
  656.        download of that specific .QWK packet. It can be the only file in the
  657.        .REP packet, or combined with replies as well. The advantage of this
  658.        feature is say your last .QWK packet was garbled upon download, or was
  659.        accidentally lost altogether. All you have to do now is include a
  660.        HMP.PTR file in a .REP upload, and your pointers are automatically
  661.        reset such that your next QMD will resend all the messages you lost.
  662.  
  663.        Which messages will actually be included in the QWK packet, and
  664.        accepted from a REP packet depends on what access you have granted the
  665.        user.  If the user has normal access (access level less then 255, and
  666.        netmail flag turned off) only public and global messages stored in the
  667.  
  668.  
  669.  
  670.                                           9
  671.  
  672.  
  673.  
  674.  
  675.  
  676.        users selected message areas will be included in the QWK packet.
  677.        Private messages specifically addressed to the user will be included
  678.        ONLY IF you have configured PY for the message area the message is
  679.        stored in.  If the users access level is 255 or it's the actual sysop,
  680.        all private messages will be included regardless of how you've
  681.        configured the PY/PN setting for the specific message area, and
  682.        regardless of the TO field contents.  If it's the actual sysop, all
  683.        messages marked as deleted will also be included.
  684.  
  685.        When processing a REP packet, QWiKer first checks the packet ID to be
  686.        sure the packet belongs to this system.  It will only accept packets
  687.        with the correct ID.  For users with normal access, QWiKer will only
  688.        store messages addressed FROM the actual users name and only in
  689.        message areas in which the users Allowed Sections flag is turned on.
  690.        Private messages in the REP packet will be stored as private in the
  691.        message base regardless of the PY/PN setting for the given message
  692.        area.  If the users access level is 255 or it's the actual sysop,
  693.        messages will be stored regardless of the FROM field.  If it's the
  694.        actual sysop, all messages will be stored regardless of the Allowed
  695.        Sections flags.
  696.  
  697.        In the case of a netmail node calling you for mail, the required
  698.        sequence is a QMD first, followed by a QMU (if they have a .REP packet
  699.        to upload) in the same call.  If the order is reversed, the node will
  700.        NOT get any mail from your system because their HMP is reset to the
  701.        tail end of the message base after the QMU operation.
  702.  
  703.        Each user, prior to running QMD for the first time, should use the SMA
  704.        (Set Message Area) command to select which message areas they wish
  705.        included in their QWK mail packet.  They should do this for all forums
  706.        they wish to participate in (to learn more about forums, see the
  707.        Auntie Sysop documentation section on doors, pages 93-99).  Auntie
  708.        turns all message areas ON by default.  This would generate an awfully
  709.        large QWK mail packet, especially for those systems connected to a
  710.        netmail network.  They should also use the HMP (High Message Pointer)
  711.        command to set a reasonable value.  Auntie starts at 0 by default, and
  712.        if your system has a reasonable number of messages in its message
  713.        base(s), an HMP value of 0 would also generate an awfully large QWK
  714.        mail packet.  Lastly, the user should verify they have selected a file
  715.        transfer protocol they can use.  Auntie will automatically
  716.        send/receive the mail packets using whatever protocol the user has
  717.        configured for without asking.
  718.  
  719.        In detail, when the user enters the command QMD, the program
  720.        MAKEQWK.EXE is actually run by Auntie.  This program starts by reading
  721.        the BBSWES.CFG file (as created by the Auntie program CONFIG.EXE), the
  722.        QWIKER.CFG file (as described in the following chapter SETUP), and the
  723.        EXTERNAL.DTA file (as generated by Auntie just before shelling out to
  724.        MAKEQWK.EXE).  For a technical layout of the BBSWES.CFG file, see the
  725.        Auntie Sysop documentation pages 160-163.  For a technical layout of
  726.        the QWIKER.CFG file, see the following chapter entitled SETUP.  For a
  727.        technical layout of the EXTERNAL.DTA file, see Appendix A.  If you are
  728.        the sysop of a multi-node system, you can create one QWIKER.CFG file
  729.        and point to its location by using the "CONFIG=" switch on the command
  730.        line of MAKEQWK (and UNPAKREP) as described below.  If this switch is
  731.  
  732.  
  733.  
  734.                                          10
  735.  
  736.  
  737.  
  738.  
  739.  
  740.        not specified, QWiKer will look for QWIKER.CFG in the current
  741.        directory.  It will abort if it cannot find it in either place.
  742.        QWiKer will also look for both the BBSWES.CFG and EXTERNAL.DTA files
  743.        in the current directory and abort if not found.
  744.  
  745.        Since QWiKer is fully aware of the users message area selection etc.,
  746.        it requires no further input from the user once started.  It does
  747.        display status to the user as it progresses in building the QWK packet
  748.        so the user can see what's happening and rest assured that the BBS
  749.        hasn't hung on them while generating the QWK packet.  As it goes
  750.        through each forum, one at a time, gathering messages, it displays a
  751.        percent completion status to the user at least once per second.  Also
  752.        as it's gathering the messages, it builds its work files in your
  753.        "Temporary Path".  At the completion of the message gathering process,
  754.        QWiKer shells out to a compression program (it will use whatever
  755.        program you have configured as your default compression type,
  756.        ARC/ZIP/LZH) to gather all the working files into one compressed .QWK
  757.        file stored on your "Path to Downloadable Files Not Listed in DIR".
  758.        After the .QWK file has been successfully created, QWiKer deletes its
  759.        work files and recreates the file EXTERNAL.DTA, and creates the files
  760.        ADDMARK.LST and QWKCLNUP.DAT.  In EXTERNAL.DTA, it returns the
  761.        MESSAGES, and HMP values to Auntie as described in Appendix A.  In
  762.        ADDMARK.LST, it returns the full name of the QWK packet that requires
  763.        sending (downloading) to the user.  In QWKCLNUP.DAT, it stores some
  764.        intermediate values that will be used later by the program
  765.        QWKCLNUP.EXE.  After sending the .QWK file to the user, Auntie
  766.        actually runs the program QWKCLNUP.EXE with a parameter of either
  767.        SUCCESS or FAILURE to indicate a successful download or an aborted
  768.        download (carrier lost of whatever).  If the download was successful,
  769.        QW2KCLNUP will read the file QWKCLNUP.DAT and update the users HMP
  770.        values in all the forums appropriately and delete the QWKCLNUP.DAT
  771.        file.  If however the download failed, QWKCLNUP will simply delete the
  772.        QWKCLNUP.DAT file.  This method enables 2 features.  First, if the
  773.        download of the QWK packet fails, the users HMP settings are not
  774.        modified such that they can call back and execute another QMD to
  775.        receive the mail they're missing.  Secondly, after a successful
  776.        download, all the HMP's are properly updated, and the user can do
  777.        another back to back QMD to obtain any remaining messages (assuming
  778.        the first packet reached one of the size limits).
  779.  
  780.        When the user enters the QMU command, Auntie starts by going into
  781.        receive mode expecting to be sent a .REP file.  Once received, Auntie
  782.        will automatically test the file for integrity using the appropriate
  783.        compression program.  After the file has passed the integrity test,
  784.        the file is moved from the -TU directory into the UL path.  Then
  785.        Auntie runs the program UNPAKREP.EXE.  Just like MAKEQWK.EXE, this
  786.        program starts by reading the BBSWES.CFG file, the QWIKER.CFG file,
  787.        and the EXTERNAL.DTA file.  It then unpacks the .REP file, begins
  788.        reading messages from it, storing them in the message base one at a
  789.        time as it goes along.  As each message is stored, a status line is
  790.        shown to the user so they know what messages were actually accepted
  791.        and stored.  If the user is a netmail caller (i.e. their netmail flag
  792.        is turned on), their HMP values will be updated such that they won't
  793.        be sent their QMU'd messages as a part of their next QMD (this is why
  794.        netmail nodes MUST perform a QMD followed by a QMU specifically in
  795.  
  796.  
  797.  
  798.                                          11
  799.  
  800.  
  801.  
  802.  
  803.  
  804.        that order).  Lastly, it erases and re-creates the EXTERNAL.DTA file,
  805.        and returns the PML and HMP values to Auntie as described in Appendix
  806.        A.
  807.  
  808.  
  809.  
  810.  
  811.  
  812.  
  813.  
  814.  
  815.  
  816.  
  817.  
  818.  
  819.  
  820.  
  821.  
  822.  
  823.  
  824.  
  825.  
  826.  
  827.  
  828.  
  829.  
  830.  
  831.  
  832.  
  833.  
  834.  
  835.  
  836.  
  837.  
  838.  
  839.  
  840.  
  841.  
  842.  
  843.  
  844.  
  845.  
  846.  
  847.  
  848.  
  849.  
  850.  
  851.  
  852.  
  853.  
  854.  
  855.  
  856.  
  857.  
  858.  
  859.  
  860.  
  861.  
  862.                                          12
  863.  
  864.  
  865.  
  866.  
  867.  
  868.        Technical Support       Technical Support
  869.        ──────────────────────────────────────────────────────────────────────
  870.        If you have any questions or problems regarding QWiKer or any other
  871.        Dataware product, please call our office for assistance.  Our office
  872.        hours are Monday through Friday, 9:30am-5:30pm Pacific time.  You can
  873.        also leave a message or pick up the latest versions on our 24-hour BBS
  874.        named "The Real Batchin' Board".  You may also mail your comments and
  875.        questions to the Dataware office.  The Dataware address and phone
  876.        numbers are as follows:
  877.  
  878.             Dataware, Inc.
  879.             Suite 2571
  880.             1420 NW Gilman Boulevard
  881.             Issaquah, Wa.  98027-7001
  882.  
  883.             Voice (9:30am to 5:30pm PT): (206) 391-9333
  884.  
  885.             The Real Batchin' Board BBS (available 24 hours): (206) 391-2330
  886.  
  887.        You can also reach us via the following:
  888.  
  889.             Auntie Support Forum BBS (available 24 hours): (510) 938-5836
  890.             Intelec Network Offline Conference
  891.  
  892.  
  893.        Registration       Registration
  894.        ──────────────────────────────────────────────────────────────────────
  895.        If you find that QWiKer is useful to you, you can become a registered
  896.        user.  As a registered user, you will receive a diskette with the
  897.        final version 1.00 (the final production release) on it when
  898.        available.  You will also automatically receive, when available, a
  899.        free upgrade to QWiKer version 1.10.  The current registration fees
  900.        are as follows:
  901.  
  902.             QWiKer on 5¼" or 3½" Diskette (please specify)           $ 50
  903.             Discount if you've registered QWiKerNet at full price    $(15)
  904.             Laser Printed Manual                                     $  3
  905.             Ups Ground                                               $  3
  906.             Ups Second Day Air                                       $  6
  907.             Ups Next Day Air                                         $ 12
  908.             All Over-seas Shipping                                   $  6
  909.             Washington residents add 8.2% sales tax to the total
  910.  
  911.        As a bonus, you may register both QWiKer and QWiKerNet for one low fee
  912.        of $75 instead of the normal full combined price of $90.
  913.  
  914.  
  915.  
  916.  
  917.  
  918.  
  919.  
  920.  
  921.  
  922.  
  923.  
  924.  
  925.  
  926.                                          13
  927.  
  928.  
  929.  
  930.  
  931.  
  932.        Appendix A - Technical layout of files used by QWiKer       Appendix A - Technical layout of files used by QWiKer
  933.        ──────────────────────────────────────────────────────────────────────
  934.  
  935.  
  936.        EXTERNAL.DTA       EXTERNAL.DTA
  937.  
  938.        EXTERNAL.DTA is a line oriented plain text file created by Auntie in
  939.        the default sub-directory.  It contains necessary information about
  940.        the users current settings that QWiKer requires for proper processing.
  941.        Auntie creates it in the following format:
  942.  
  943.        Line 1: An integer in the range 1-32767 indicating the record number
  944.                in the USERS. file that belongs to the caller.
  945.        Line 2: The caller's logon name.  May be up to 31 characters in
  946.                length.
  947.        Line 3: Will contain either "Local" if in local mode or the DCE
  948.                (modem-to-modem) speed of the caller (300/1200/2400/9600/
  949.                14400/19200/etc).
  950.        Line 4: Either an "E" for even parity or an "N" for no parity
  951.        Line 5: The caller's (or SysOp's) High Message Pointer (1-9999999).
  952.        Line 6: The caller's (or SysOp's) ZIPM counter number (0-99).
  953.        Line 7: The caller's (or SysOp's) SSO setting.  0 equates to off.  A
  954.                non-zero value indicates an SSO setting for that specific
  955.                message section (1-255).
  956.  
  957.        When MAKEQWK has finished its processing, it erases the contents of
  958.        this file and stores two new lines in it.  These lines are as follows:
  959.  
  960.        Line 1: HMP n. Where n is the highest message number (1-9999999) from
  961.                the main forum (forum 1) that was included in the mail packet.
  962.        Line 2: MESSAGES n. Where n is the total number of messages (1-32767)
  963.                put into the mail packet.
  964.  
  965.        When UNPAKREP has finished it's processing, it to erases the contents
  966.        of this file and stores two new lines in it.  These lines are as
  967.        follows:
  968.  
  969.        Line 1: PML n. Where n is the total number of Personal Messages Left
  970.                (1-32767).
  971.        Line 2: HMP n. Where n is the highest message number (1-9999999) from
  972.                the main forum (forum 1) that was included in the mail packet.
  973.                This line is included ONLY IF the caller is a netmail caller
  974.                (the netmail flag is turned on in the users account).
  975.  
  976.        ADDMARK.LST       ADDMARK.LST
  977.        Another file that MAKEQWK creates after it has finished processing is
  978.        ADDMARK.LST.  This file is a plain ASCII text file, in which each line
  979.        is the name of a file that requires sending to the user.  The first
  980.        line will always read "xxxxxnn.QWK".  This is the name of the QWK file
  981.        actually generated and ready to be downloaded by the user.  Additional
  982.        lines will be of files requested for download by the user via a mail
  983.        door message.
  984.  
  985.  
  986.  
  987.  
  988.  
  989.  
  990.                                          14
  991.  
  992.  
  993.  
  994.  
  995.  
  996.        Appendix B - QWK-REP Mail Packet File Formats       Appendix B - QWK-REP Mail Packet File Formats
  997.        ──────────────────────────────────────────────────────────────────────
  998.  
  999.  
  1000.        QWK Mail Packet Structure Definition       QWK Mail Packet Structure Definition
  1001.  
  1002.        This appendix thoroughly describes the structure of the QWK-REP mail
  1003.        packets that have become so very popular among various bulletin
  1004.        boards.  This information is copyright 1991 by Dataware, Inc., and was
  1005.        gathered from many other documents, as well as experimentation.
  1006.        Dataware, Inc. gratefully acknowledges Mark (Sparky) Herring for
  1007.        developing the original Qmail door which utilizes this structure.
  1008.  
  1009.        .QWK packets are composed of 3 file formats, CONTROL.DAT,
  1010.        MESSAGES.DAT, and nnn.NDX files.  Each of the file formats are
  1011.        described in the following text.
  1012.  
  1013.  
  1014.        MESSAGES.DAT File Format       MESSAGES.DAT File Format
  1015.        This file contains all of the messages in the packet, along with their
  1016.        headers.  It is composed of 128 byte records.  The very first record
  1017.        is always the mail door copyright message.  The second record is the
  1018.        message header for the first message in the packet.  Immediately
  1019.        following this record, are all the records for the first message.  The
  1020.        next record following the message records is the message header for
  1021.        the 2nd message in the packet.  Again followed by the records for the
  1022.        message itself.  This layout (header record/message records) continues
  1023.        for all messages in the packet, at which point this file simply ends
  1024.        (except for netmail packets as described below).  NOTE: there is no
  1025.        indication of how many messages are in the packet.  The only way to
  1026.        determine this information is to scan the packet and actually count
  1027.        the number of messages.
  1028.  
  1029.        The 128 byte message headers have the following structure.  All ASCII
  1030.        fields are left aligned and padded on the right with spaces:
  1031.  
  1032.        Offset  Length  Description
  1033.        ──────  ──────  ──────────────────────────────────────────────────
  1034.        1       1       Message status flag:
  1035.                          ' ' = public
  1036.                          '-' = public and read
  1037.                          '*' = private
  1038.                          '+' = private and read
  1039.        2       7       Message Number in ASCII
  1040.        9       8       Date (mm-dd-yy) in ASCII
  1041.        17      5       Time (hh:mm) in ASCII
  1042.        22      25      To
  1043.        47      25      From
  1044.        72      25      Subject
  1045.        97      12      Password (always filled with spaces)
  1046.        109     8       Parent (reference) message number in ASCII
  1047.        117     6       Number of 128 byte blocks in message (including
  1048.                        the header) in ASCII. Minimum value is 2
  1049.        123     1       Message alive status:
  1050.                          'ß' = Message is alive
  1051.  
  1052.  
  1053.  
  1054.                                          15
  1055.  
  1056.  
  1057.  
  1058.  
  1059.  
  1060.                          'Γ' = Message has been marked as "Killed" or Deleted
  1061.        124     1       Lsb of conference number (0-255)
  1062.        125     1       Msb of conference number in new format for > 256
  1063.                        conferences. Space in the original standard.
  1064.        126     3       Space filled
  1065.  
  1066.        The message records are all 128 bytes each, with a 'π' character used
  1067.        as a new line separator.  The last line of the message text is padded
  1068.        with spaces as required to fill out the 128 byte record size
  1069.        requirement.
  1070.  
  1071.  
  1072.        Modification for Netmail packets       Modification for Netmail packets
  1073.        In order to provide some form of security and prevent sysops from
  1074.        "stealing" the message base of another BBS, a set of net status flags
  1075.        are added to the QWK packets which indicate which conferences are
  1076.        enabled for netmail and which aren't.  Most QWK-REP mail doors are
  1077.        configurable on a user by user basis as to which conferences the user
  1078.        has been granted netmail access.  If the user has no netmail access,
  1079.        or else the mail door does not support netmail, these flags will be
  1080.        missing from the QWK packet.
  1081.  
  1082.        These flags are stored as additional 128 byte records appended to the
  1083.        end of the MESSAGES.DAT file.  Each byte in each record contains one
  1084.        flag for one specific conference.  If the flag is non-zero, netmail is
  1085.        permitted for that specific conference number.  If the flag is zero,
  1086.        netmail is NOT permitted for that specific conference number.
  1087.  
  1088.        The flags are positional sensitive so that the very last 128 byte
  1089.        record in the MESSAGES.DAT file contains flags for conferences 0-127,
  1090.        sequentially.  If additional flags are required for more conferences,
  1091.        additional 128 byte records will be stored preceding the last one.  So
  1092.        the second to last record contains flags for conferences 128-255.  The
  1093.        third to last record contains flags for conferences 256-383.  And so
  1094.        on for as many conferences exist that require netmail flags.
  1095.  
  1096.        In addition to net status flags, netmail QWK packets generally do not
  1097.        include any nnn.NDX files as they are not required nor used by the
  1098.        netmail importing software.  There are no changes to the REP packets
  1099.        to support netmail.
  1100.  
  1101.  
  1102.        nnn.NDX File Format       nnn.NDX File Format
  1103.        This file contains an array of 5 byte pointers to the message headers
  1104.        stored in the MESSAGES.DAT file.  There can be many nnn.NDX files, one
  1105.        for each conference that has been included in the packet.  Conference
  1106.        0 would be indicated by the existence of the file 000.NDX.  Conference
  1107.        1 by 001.NDX, conference 10 by 010.NDX, conference 200 by 200.NDX,
  1108.        etc.  Only conferences which have actual messages included in the
  1109.        packet will have an nnn.NDX file included for them.  There may also be
  1110.        a PERSONAL.NDX file included in the packet.  This file follows the
  1111.        same format as the nnn.NDX file, but points to all messages included
  1112.        in the packet that are addressed TO the user.  Each pointer in the
  1113.        nnn.NDX files has the following structure:
  1114.  
  1115.  
  1116.  
  1117.  
  1118.                                          16
  1119.  
  1120.  
  1121.  
  1122.  
  1123.  
  1124.        Offset  Length  Description
  1125.        ──────  ──────  ─────────────────────────────────────────────────────
  1126.        1       4       MSBIN floating point format of the Record number of
  1127.                        the message header in the MESSAGES.DAT file.  This
  1128.                        field is 1 based, and since the very first record is a
  1129.                        mail door info record, the first record will always be
  1130.                        2 in this field.  NOTE: Be careful with this entry.
  1131.                        It does NOT follow the IEEE standard that MS has
  1132.                        switched to for their standard.  MSC 6.0 has 2
  1133.                        functions for converting between IEEE and MSBIN
  1134.                        format.  But all calculations are done in the IEEE
  1135.                        format.  And in the latest QBasic you must explicitly
  1136.                        tell it to use the old MSBIN format instead of the
  1137.                        default IEEE format.
  1138.        5       1       Conference number of this message.  Recommended to
  1139.                        just ignore this byte, and use the Conference number
  1140.                        in the message header for > 256 conference support.
  1141.  
  1142.  
  1143.        CONTROL.DAT File Format       CONTROL.DAT File Format
  1144.        This file is an ASCII text file that contains information about the
  1145.        BBS the packet was downloaded from, and about all the conferences the
  1146.        user has access to.  Each line has a specific purpose.  The lines are
  1147.        defined as follows:
  1148.  
  1149.        Line 1: The full name of the BBS.
  1150.        Line 2: The City,State where the BBS is located.
  1151.        Line 3: The primary phone number of the BBS.
  1152.        Line 4: The SysOps name followed by ", Sysop" on the same line.
  1153.        Line 5: The 5 digit serial number of the mail door followed by the
  1154.                base name of the QWK packet.  These two fields are separated
  1155.                by a comma.
  1156.        Line 6: The Date & Time the packet was generated.  Stored in the
  1157.                format "MM-DD-YYYY,HH:MM:SS".
  1158.        Line 7: The name of the user the packet belongs to.
  1159.        Line 8: Always an empty line.
  1160.        Line 9-10:     A single "0" on each line (purpose unknown at this
  1161.                time)
  1162.        Line 11:  The number of conference descriptions following, minus 1.
  1163.        Line 12:  The conference number of the first conference description.
  1164.        Line 13:  The 10 character maximum conference name of the first
  1165.                conference.
  1166.        Line 14:  The conference number of the second conference description.
  1167.        Line 15:  The 10 character maximum conference name of the second
  1168.                conference.
  1169.        .
  1170.        .
  1171.        .
  1172.        .
  1173.        Line n: The conference number of the last conference description.
  1174.        Line n+1: The 10 character maximum conference name of the last
  1175.                conference.
  1176.        Line n+2: The filename of the optional logon file to display.
  1177.        Line n+3: The filename of the optional news file to display.
  1178.        Line n+4: The filename of the optional logoff file to display.
  1179.  
  1180.  
  1181.  
  1182.                                          17
  1183.  
  1184.  
  1185.  
  1186.  
  1187.  
  1188.  
  1189.  
  1190.        BULLETINS Format       BULLETINS Format
  1191.        If bulletins are included in the packet, the names of the bulletin
  1192.        files must follow the format "BLT-ccc.nnn".  Where "ccc" is the
  1193.        conference number the bulletin is associated with (0-999) and "nnn" is
  1194.        the number of the bulletin (1-999).
  1195.  
  1196.  
  1197.  
  1198.  
  1199.  
  1200.  
  1201.  
  1202.  
  1203.  
  1204.  
  1205.  
  1206.  
  1207.  
  1208.  
  1209.  
  1210.  
  1211.  
  1212.  
  1213.  
  1214.  
  1215.  
  1216.  
  1217.  
  1218.  
  1219.  
  1220.  
  1221.  
  1222.  
  1223.  
  1224.  
  1225.  
  1226.  
  1227.  
  1228.  
  1229.  
  1230.  
  1231.  
  1232.  
  1233.  
  1234.  
  1235.  
  1236.  
  1237.  
  1238.  
  1239.  
  1240.  
  1241.  
  1242.  
  1243.  
  1244.  
  1245.  
  1246.                                          18
  1247.  
  1248.  
  1249.  
  1250.  
  1251.  
  1252.        REP Mail Packet Structure Definitions       REP Mail Packet Structure Definitions
  1253.  
  1254.        .REP packets consist of only 1 file format.  The base name of this
  1255.        file is always taken from the second parameter of line 5 in the
  1256.        CONTROL.DAT file.  The extension is always .MSG.  Thus if the sysop
  1257.        has configured his mail door for a base name of BATCHN, the filename
  1258.        of the file in the .REP packet will be BATCHN.MSG.  In addition, the
  1259.        base name of the .REP packet uses this same CONTROL.DAT parameter.
  1260.        Thus the .REP packet would be named BATCHN.REP.
  1261.  
  1262.        The format of the .MSG file is nearly identical to that of the
  1263.        MESSAGES.DAT file.  The major difference is in the first 128 byte
  1264.        record.  The first 8 characters always contain the base name of the
  1265.        mail packet, padded with spaces as necessary to fill out the record.
  1266.        Thus continuing our example, the first 8 characters would be
  1267.        "BATCHN  ", and the rest of the 128 byte record would be filled with
  1268.        spaces.
  1269.  
  1270.        The remainder of the packet follows the exact same 128 byte record
  1271.        format as used for MESSAGES.DAT (as described above) with the
  1272.        following variances:
  1273.  
  1274.        1) The conference number is stored in ASCII format in place of the
  1275.        message number
  1276.  
  1277.        2) The conference number field may be filled with spaces or the real
  1278.        conference number.
  1279.  
  1280.  
  1281.  
  1282.  
  1283.  
  1284.  
  1285.  
  1286.  
  1287.  
  1288.  
  1289.  
  1290.  
  1291.  
  1292.  
  1293.  
  1294.  
  1295.  
  1296.  
  1297.  
  1298.  
  1299.  
  1300.  
  1301.  
  1302.  
  1303.  
  1304.  
  1305.  
  1306.  
  1307.  
  1308.  
  1309.  
  1310.                                          19
  1311.  
  1312.  
  1313.  
  1314.  
  1315.  
  1316.        History       History
  1317.        ──────────────────────────────────────────────────────────────────────
  1318.  
  1319.        v0.60 07/29/91 - Completely restructured the configuration file format
  1320.                         in preparation for scanning multiple forums at once,
  1321.                         placing messages in the appropriate conference.
  1322.                       - Eliminated the use of the BBSECT.NAM file in favor of
  1323.                         the conference name now being specified in the
  1324.                         configuration file.
  1325.                       - Scan multiple forums, gathering new messages, and
  1326.                         sorting them into the correct conference number
  1327.                         assignment.
  1328.                       - Include Deleted messages in QWK packet if user is
  1329.                         sysop or is a 255er.
  1330.                       - Fixed bug in which messages in section 64 would
  1331.                         always be included in the QWK packet.
  1332.                       - Do not include GLOBAL messages in QWK packets for
  1333.                         netmail callers.
  1334.                       - Optimized code for improved scanning speed when
  1335.                         creating a QWK packet.
  1336.                       - When configured to use PKZIP, include the "-es"
  1337.                         command line switch to force it to use the much
  1338.                         faster Shrinking method when caller is at 4800 or
  1339.                         greater, or is local.  These users can generally
  1340.                         transfer data faster then the additional compression
  1341.                         saved by the use of Imploding.
  1342.                       - Fixed bug which would cause MAKEQWK to sometimes not
  1343.                         read the command line parameters properly.
  1344.                       - Store the checksum of the TO field for the new Auntie
  1345.                         v512 MSGTO.IND file.
  1346.                       - Skip over any message contained in a REP packet that
  1347.                         are addressed "TO: QWIKER".  These are the
  1348.                         ADD/DROP/RESET commands.
  1349.                       - Fixed bug where node number was random for single
  1350.                         node setups.
  1351.        v0.61 08/20/91 - Added communication routines so that QWiKer can talk
  1352.                         to the user through the modem.
  1353.                       - Added "/CONFIG=" command line switch to point to the
  1354.                         QWIKER.CFG file.
  1355.                       - Make Forum 1 an automatically implied forum as the
  1356.                         current sub-directory.  A result of this is "Forum 1"
  1357.                         must NOT be defined in the QWIKER.CFG file.
  1358.                       - Detect loss of carrier during MAKEQWK and abort the
  1359.                         operation.
  1360.                       - Present more information to the user, including
  1361.                         number of messages packed, number of personal
  1362.                         messages found, and what messages were imported along
  1363.                         with where.
  1364.                       - Fixed bug in which messages stored when configured
  1365.                         for "Today" were stored as 1971 messages instead of
  1366.                         1991
  1367.        v0.62 12/04/91 - Modified to match the new file formats of 5.12.
  1368.                       - Corrected Checksum generator when importing messages
  1369.                         via QMU.
  1370.  
  1371.  
  1372.  
  1373.  
  1374.                                          20
  1375.  
  1376.  
  1377.  
  1378.  
  1379.  
  1380.                       - Added the QWKCLNUP program to update the HMP values
  1381.                         only after a successful QWK packet download.
  1382.                       - Fixed a bug in which the names of conferences 128-255
  1383.                         were not being included in the CONTROL.DAT file.
  1384.                       - Handle importing of messages into message base with
  1385.                         >32767 records
  1386.                       - Pay attention to all 32 bytes of Allowed and Selected
  1387.                         sections. Not just the first 8.
  1388.                       - Added support of a HMP.PTR file to be used for
  1389.                         resetting the HMP's of all the forums at once.
  1390.                       - Correctly detect the conference number in a .REP
  1391.                         packet as stored by the program WinQWK.
  1392.                       - Replace ARC with ARJ support.
  1393.                       - Open QWIKER.CFG and BBSWES.CFG files in share
  1394.                         compatibility mode.
  1395.                       - Use a 16 bit counter instead of an 8 bit counter for
  1396.                         the number of messages/conference count.
  1397.                       - Handle case where users HMP is 0.
  1398.                       - Do not delete "*.QWK" upon startup. Delete the
  1399.                         specific .QWK file created during the QWKCLNUP phase
  1400.                         instead.
  1401.                       - In the event of a .QWK filename conflict between
  1402.                         multiple nodes, increment the Counter until the
  1403.                         conflict is resolved.
  1404.        v0.63 01/09/92 - Handle messages up to 12800 bytes in length.
  1405.        v0.64 02/01/92 - Fixed bug where the ALLOWED flags for message areas
  1406.                         65-255 were not being read properly causing some
  1407.                         messages to not be stored during a QMU.
  1408.                       - Fixed bug where "Not Echoed" and "Global" messages
  1409.                         were being sent to netmail callers.
  1410.        v0.65 03/25/92 - Added support for an alias name table called
  1411.                         ALIAS.NAM.
  1412.                       - Accept SSO sections that are allowed, but not
  1413.                         selected.
  1414.                       - Bump "Messages Left" counter in each forum during a
  1415.                         QMU.
  1416.                       - Append correct number of NetStatus flags based on
  1417.                         highest conference number defined.
  1418.                       - Include a SESSION.TXT file in the QWK packet listing
  1419.                         the number of messages in each conference included in
  1420.                         the packet.
  1421.                       - Do not display the list showing the number of
  1422.                         messages included for each conference when the caller
  1423.                         is a Netmail caller.
  1424.                       - Public/Read messages were being stored as Private
  1425.                         messages by mistake. Fixed.
  1426.                       - If Auntie is configured to readdress messages
  1427.                         "TO:SYSOP", messages stored as such will have the
  1428.                         sysops configured name put in the TO field instead.
  1429.                       - Trap the DOS console and display all text in a DOS
  1430.                         window and copy it out the modem port to the user.
  1431.  
  1432.  
  1433.  
  1434.  
  1435.  
  1436.  
  1437.  
  1438.                                          21